<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/container/hash_set.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('hash__set_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">hash_set.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="hash__set_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * @file hash_set.h The unordered set to store unique keys.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef _HASH_SET_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _HASH_SET_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;../util.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">/** HashSetData is the data type for the container private information. */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="hash__set_8h.html#a3f18c37126779d3a8c5e05da64491c8e">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_HashSetData <a class="code" href="hash__set_8h.html#a3f18c37126779d3a8c5e05da64491c8e">HashSetData</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/** The implementation for hash set. */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structHashSet.html">   14</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_HashSet {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    /** The container private information */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structHashSet.html#a01595b67fca3eb3c78e1ba2f27f2ecc9">   16</a></span>&#160;    <a class="code" href="hash__set_8h.html#a3f18c37126779d3a8c5e05da64491c8e">HashSetData</a> *<a class="code" href="structHashSet.html#a01595b67fca3eb3c78e1ba2f27f2ecc9">pData</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">    /** Insert a key into the set.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">        @see HashSetAdd */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structHashSet.html#a3a87a0740e3343d0395d9e5b368abb28">   20</a></span>&#160;    int32_t (*add) (<span class="keyword">struct </span>_HashSet*, Key, size_t);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    /** Check if the set contains the designated key.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">        @see HashSetFind */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structHashSet.html#abe4870ba7cf6e306fcb9a317f21d2249">   24</a></span>&#160;    int32_t (*find) (<span class="keyword">struct </span>_HashSet*, Key, size_t);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    /** Delete the designated key from the set.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">        @see HashSetRemove */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structHashSet.html#a2c9af94dcbc527d9df74acee6fedf59c">   28</a></span>&#160;    int32_t (*<span class="keyword">remove</span>) (<span class="keyword">struct </span>_HashSet*, Key, size_t);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">    /** Return the number of stored unique keys.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">        @see HashSetSize */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structHashSet.html#a9712e6c03042cad84a80d88ae4daf6be">   32</a></span>&#160;    int32_t (*size) (<span class="keyword">struct </span>_HashSet*);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    /** Iterate through the set to retrieve each key.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">        @see HashSetIterate */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structHashSet.html#ac9477149524e68fa4db94fa3a54b8d37">   36</a></span>&#160;    int32_t (*iterate) (<span class="keyword">struct </span>_HashSet*, bool, Key*);</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    /** Set the custom key resource clean method.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">        @see HashSetSetDestroy */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structHashSet.html#af72cbe44882afada033f555b5bdbdf76">   40</a></span>&#160;    int32_t (*set_destroy) (<span class="keyword">struct </span>_HashSet*, void (*) (Key));</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">    /** Set the custom hash function.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">        @see HashSetSetHash */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structHashSet.html#ac975021efd7932687d397d556b99eb31">   44</a></span>&#160;    int32_t (*set_hash) (<span class="keyword">struct </span>_HashSet*, uint32_t (*) (Key, size_t));</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;} <a class="code" href="structHashSet.html">HashSet</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">/*===========================================================================*</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> *             Definition for the exported member operations                 *</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> *===========================================================================*/</span><span class="comment"></span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> * @brief The constructor for HashSet.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be constructed set</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for set construction</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a16e1ba88032036d7fd93add6769cd7a0">HashSetInit</a>(<a class="code" href="structHashSet.html">HashSet</a> **ppObj);</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> * @brief The destructor for HashSet.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> * If the custom resource clean method is set, it also runs the clean method</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> * for each pair.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be destructed set</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="keywordtype">void</span> <a class="code" href="hash__set_8h.html#aceba9e2cf41208f9637ab1df23c62e4b">HashSetDeinit</a>(<a class="code" href="structHashSet.html">HashSet</a> **ppObj);</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> * @brief Insert a key into the set.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * This function inserts a key into the set. If the designated key is the same</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * with a certain one stored in the set, that key will be replaced to maintain</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * the element uniqueness. Also, if the custom resource clean method is set, it</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * runs the resource clean method for the replaced key.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * @param key           The designated key</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * @param size          Key size in bytes</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for set extension</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * @retval ERR_KEYSIZE  Invalid key size</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * @note The key should be the pointer to the data you plan to hash for.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a0fa05d698a7c3f57d6cb908316a770fa">HashSetAdd</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>, Key key, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> * @brief Check if the set contains the designated key.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * @param key           The designated key</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> * @param size          Key size in bytes</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @retval SUCC         The key can be found</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> * @retval NOKEY        The key cannot be found</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> * @retval ERR_KEYSIZE  Invalid key size</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * @note The key should be the pointer to the data you plan to hash for.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;int32_t <a class="code" href="hash__set_8h.html#ab3d7f359f3b9c6b31660c72c987c42f0">HashSetFind</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>, Key key, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @brief Delete the designated key from the set.</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> * This function deletes the designated key from the set. If the custom resource</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> * clean method is set, it also runs the clean method for the deleted key.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"> * @param key           The designated key</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> * @param size          Key size in bytes</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> * @retval ERR_NODATA   No set entry can be found</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * @retval ERR_KEYSIZE  Invalid key size</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> * @note The key should be the pointer to the data you plan to hash for.</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a6f84161453ce14a4600fb1e49307a51f">HashSetRemove</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>, Key key, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> * @brief Return the number of stored unique keys.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * @return              The number of stored pairs</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;int32_t <a class="code" href="hash__set_8h.html#ac118a8c9a09d5879f5a2755cc3cb7b68">HashSetSize</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> * @brief Iterate through the set to retrieve each key.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> * Before iterating through the set, it is necessary to pass:</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> *  - bReset = true</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> *  - pKey = NULL</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> * for iterator initialization.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * After initialization, you can pass:</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> *  - bReset = false</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> *  - pKey = the pointer to get the returned key at each iteration.</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"> * @param bReset        The knob to restart the iteration</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"> * @param pKey          The pointer to the returned key</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"> * @retval SUCC         Iterator initialized successfully</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> * @retval CONTINUE     Iteration in progress</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment"> * @retval END          Iteration terminated</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> * @retval ERR_GET      Invalid parameter to store returned key</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"> * @note Please do not insert or delete keys during set traversal</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a42f4c28d1ff6a6b96a1e62faebb93d39">HashSetIterate</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>, <span class="keywordtype">bool</span> bReset, Key *pKey);</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * @brief Set the custom key resource clean method.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;int32_t <a class="code" href="hash__set_8h.html#ad6a086c3dbcf81fa50b95498a400b3d9">HashSetSetDestroy</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>, <span class="keywordtype">void</span> (*pFunc) (Key));</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> * @brief Set the custom hash function.</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"> * The default hash function is HashMurMur32.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"> * @param self          The pointer to HashSet structure</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a1363a0b1f2f9ca0bbfec951f1afb67f7">HashSetSetHash</a>(<a class="code" href="structHashSet.html">HashSet</a> *<span class="keyword">self</span>, uint32_t (*pFunc) (Key, <span class="keywordtype">size_t</span>));</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"> * @brief Perform union operation for the designated two sets and create the</span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment"> *  result set.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment"> * @param pFst          The pointer to the first source set</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment"> * @param pSnd          The pointer to the second source set</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"> * @param ppDst         The double pointer to the to be created result set</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized source sets</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for new set creation</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment"> * @note The newly created set will not delegate any key resource clean methods</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment"> *  from two source sets. You can still set the clean method for it. However, to</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment"> *  avoid the &quot;double-free&quot; problem, it is better to let the source sets handle</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment"> *  the resource clean issue and treat the new set as the pure result from the</span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment"> *  union operation.</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a5e734b7f8ec66af3f334294b0dde7710">HashSetUnion</a>(<a class="code" href="structHashSet.html">HashSet</a> *pFst, <a class="code" href="structHashSet.html">HashSet</a> *pSnd, <a class="code" href="structHashSet.html">HashSet</a> **ppDst);</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment"> * @brief Perform intersection operation for the designated two sets and create</span></div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment"> *  the result set.</span></div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;<span class="comment"> * @param pFst          The pointer to the first source set</span></div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment"> * @param pSnd          The pointer to the second source set</span></div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment"> * @param ppDst         The double pointer to the to be created result set</span></div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized source sets</span></div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for new set creation</span></div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment"> * @note The newly created set will not delegate any key resource clean methods</span></div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment"> *  from two source sets. You can still set the clean method for it. However, to</span></div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;<span class="comment"> *  avoid the &quot;double-free&quot; problem, it is better to let the source sets handle</span></div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment"> *  the resource clean issue and treat the new set as the pure result from the</span></div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment"> *  intersection operation.</span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;int32_t <a class="code" href="hash__set_8h.html#a8efd46cac55c3cf96f6005265fc55a7c">HashSetIntersect</a>(<a class="code" href="structHashSet.html">HashSet</a> *pFst, <a class="code" href="structHashSet.html">HashSet</a> *pSnd, <a class="code" href="structHashSet.html">HashSet</a> **ppDst);</div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment"> * @brief Perform difference operation for the first source set against the</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment"> *  second source set and create the result set.</span></div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="comment"> * @param pFst          The pointer to the first source set</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment"> * @param pSnd          The pointer to the second source set</span></div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment"> * @param ppDst         The double pointer to the to be created result set</span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized source sets</span></div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for new set creation</span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment"> * @note The newly created set will not delegate any key resource clean methods</span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment"> *  from two source sets. You can still set the clean method for it. However, to</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment"> *  avoid the &quot;double-free&quot; problem, it is better to let the source sets handle</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment"> *  the resource clean issue and treat the new set as the pure result from the</span></div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment"> *  difference operation.</span></div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;int32_t <a class="code" href="hash__set_8h.html#aaeb012c22892da0c924e6dc0e4df768a">HashSetDifference</a>(<a class="code" href="structHashSet.html">HashSet</a> *pFst, <a class="code" href="structHashSet.html">HashSet</a> *pSnd, <a class="code" href="structHashSet.html">HashSet</a> **ppDst);</div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;</div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="hash__set_8h_html_a3f18c37126779d3a8c5e05da64491c8e"><div class="ttname"><a href="hash__set_8h.html#a3f18c37126779d3a8c5e05da64491c8e">HashSetData</a></div><div class="ttdeci">struct _HashSetData HashSetData</div><div class="ttdoc">HashSetData is the data type for the container private information. </div><div class="ttdef"><b>Definition:</b> <a href="hash__set_8h_source.html#l00011">hash_set.h:11</a></div></div>
<div class="ttc" id="hash__set_8h_html_a1363a0b1f2f9ca0bbfec951f1afb67f7"><div class="ttname"><a href="hash__set_8h.html#a1363a0b1f2f9ca0bbfec951f1afb67f7">HashSetSetHash</a></div><div class="ttdeci">int32_t HashSetSetHash(HashSet *self, uint32_t(*pFunc)(Key, size_t))</div><div class="ttdoc">Set the custom hash function. </div></div>
<div class="ttc" id="structHashSet_html_a01595b67fca3eb3c78e1ba2f27f2ecc9"><div class="ttname"><a href="structHashSet.html#a01595b67fca3eb3c78e1ba2f27f2ecc9">HashSet::pData</a></div><div class="ttdeci">HashSetData * pData</div><div class="ttdoc">The container private information. </div><div class="ttdef"><b>Definition:</b> <a href="hash__set_8h_source.html#l00016">hash_set.h:16</a></div></div>
<div class="ttc" id="hash__set_8h_html_a0fa05d698a7c3f57d6cb908316a770fa"><div class="ttname"><a href="hash__set_8h.html#a0fa05d698a7c3f57d6cb908316a770fa">HashSetAdd</a></div><div class="ttdeci">int32_t HashSetAdd(HashSet *self, Key key, size_t size)</div><div class="ttdoc">Insert a key into the set. </div></div>
<div class="ttc" id="hash__set_8h_html_a8efd46cac55c3cf96f6005265fc55a7c"><div class="ttname"><a href="hash__set_8h.html#a8efd46cac55c3cf96f6005265fc55a7c">HashSetIntersect</a></div><div class="ttdeci">int32_t HashSetIntersect(HashSet *pFst, HashSet *pSnd, HashSet **ppDst)</div><div class="ttdoc">Perform intersection operation for the designated two sets and create the result set. </div></div>
<div class="ttc" id="hash__set_8h_html_ac118a8c9a09d5879f5a2755cc3cb7b68"><div class="ttname"><a href="hash__set_8h.html#ac118a8c9a09d5879f5a2755cc3cb7b68">HashSetSize</a></div><div class="ttdeci">int32_t HashSetSize(HashSet *self)</div><div class="ttdoc">Return the number of stored unique keys. </div></div>
<div class="ttc" id="hash__set_8h_html_aceba9e2cf41208f9637ab1df23c62e4b"><div class="ttname"><a href="hash__set_8h.html#aceba9e2cf41208f9637ab1df23c62e4b">HashSetDeinit</a></div><div class="ttdeci">void HashSetDeinit(HashSet **ppObj)</div><div class="ttdoc">The destructor for HashSet. </div></div>
<div class="ttc" id="hash__set_8h_html_ad6a086c3dbcf81fa50b95498a400b3d9"><div class="ttname"><a href="hash__set_8h.html#ad6a086c3dbcf81fa50b95498a400b3d9">HashSetSetDestroy</a></div><div class="ttdeci">int32_t HashSetSetDestroy(HashSet *self, void(*pFunc)(Key))</div><div class="ttdoc">Set the custom key resource clean method. </div></div>
<div class="ttc" id="hash__set_8h_html_a6f84161453ce14a4600fb1e49307a51f"><div class="ttname"><a href="hash__set_8h.html#a6f84161453ce14a4600fb1e49307a51f">HashSetRemove</a></div><div class="ttdeci">int32_t HashSetRemove(HashSet *self, Key key, size_t size)</div><div class="ttdoc">Delete the designated key from the set. </div></div>
<div class="ttc" id="structHashSet_html"><div class="ttname"><a href="structHashSet.html">HashSet</a></div><div class="ttdoc">The implementation for hash set. </div><div class="ttdef"><b>Definition:</b> <a href="hash__set_8h_source.html#l00014">hash_set.h:14</a></div></div>
<div class="ttc" id="hash__set_8h_html_ab3d7f359f3b9c6b31660c72c987c42f0"><div class="ttname"><a href="hash__set_8h.html#ab3d7f359f3b9c6b31660c72c987c42f0">HashSetFind</a></div><div class="ttdeci">int32_t HashSetFind(HashSet *self, Key key, size_t size)</div><div class="ttdoc">Check if the set contains the designated key. </div></div>
<div class="ttc" id="hash__set_8h_html_a42f4c28d1ff6a6b96a1e62faebb93d39"><div class="ttname"><a href="hash__set_8h.html#a42f4c28d1ff6a6b96a1e62faebb93d39">HashSetIterate</a></div><div class="ttdeci">int32_t HashSetIterate(HashSet *self, bool bReset, Key *pKey)</div><div class="ttdoc">Iterate through the set to retrieve each key. </div></div>
<div class="ttc" id="hash__set_8h_html_aaeb012c22892da0c924e6dc0e4df768a"><div class="ttname"><a href="hash__set_8h.html#aaeb012c22892da0c924e6dc0e4df768a">HashSetDifference</a></div><div class="ttdeci">int32_t HashSetDifference(HashSet *pFst, HashSet *pSnd, HashSet **ppDst)</div><div class="ttdoc">Perform difference operation for the first source set against the second source set and create the re...</div></div>
<div class="ttc" id="hash__set_8h_html_a5e734b7f8ec66af3f334294b0dde7710"><div class="ttname"><a href="hash__set_8h.html#a5e734b7f8ec66af3f334294b0dde7710">HashSetUnion</a></div><div class="ttdeci">int32_t HashSetUnion(HashSet *pFst, HashSet *pSnd, HashSet **ppDst)</div><div class="ttdoc">Perform union operation for the designated two sets and create the result set. </div></div>
<div class="ttc" id="hash__set_8h_html_a16e1ba88032036d7fd93add6769cd7a0"><div class="ttname"><a href="hash__set_8h.html#a16e1ba88032036d7fd93add6769cd7a0">HashSetInit</a></div><div class="ttdeci">int32_t HashSetInit(HashSet **ppObj)</div><div class="ttdoc">The constructor for HashSet. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e0f5f6345e438c73b9ae78ec2940718c.html">container</a></li><li class="navelem"><a class="el" href="hash__set_8h.html">hash_set.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
